Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Frame omni bencher docs #6642

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

rainbow-promise
Copy link

Resolves #6392

@cla-bot-2021
Copy link

cla-bot-2021 bot commented Nov 25, 2024

User @rainbow-promise, please sign the CLA here.

@iulianbarbu
Copy link
Contributor

My initial intention with #6392 was to make frame-omni-bencher look more like chain-spec-builder in terms of docs and ensuring the commands examples are backed by tests (not necessarily asserting on what they produce, but how they look like - flags, arguments etc). I haven't thought initially to add frame-omni-bencher material to the reference_docs, and there seems to be a page describing things at a high-level: https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_benchmarking_weight/index.html.

Better to focus on the frame-omni-bencher README.md level docs for the scope of this PR.

@iulianbarbu
Copy link
Contributor

Hey @rainbow-promise ! How it is going?

I am wondering if you'd like to continue the work here, or take a break. I would be happy to continue looking over this if you can contribute.

@rainbow-promise
Copy link
Author

Would like to continue @iulianbarbu, who knew docs would be this complex 🙃.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve frame-omni-bencher docs
2 participants